Get Invites

List all pending invites for a company or team. User must be team_admin for teams or org_admin for companies.

GET /v2/invites

Try it

Get Invites

cURL

curl --request GET \
  --url https://b2b-api.dev-riseworks.io/v2/invites \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "data": [
    {
      "nanoid": "<string>",
      "role": "contractor",
      "invitee_name": "<string>",
      "email": "[e-mail]",
      "inviter_name": "<string>",
      "inviter_email": "[e-mail]",
      "company": {
        "name": "<string>",
        "avatar": "<string>"
      },
      "team": {
        "name": "<string>",
        "avatar": "<string>"
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

nanoid · required

The nanoid of the company or team to get invites for TeamNanoid

Required string length: 15

Response

200

application/json

Default Response

success · enum<boolean> · required

Available options: true, false

data · object[] · required

Show child attributes

data. nanoid · string · required

data. role · enum<string> | null · required

Available options: contractor, org_admin, org_finance_admin, org_viewer, team_admin, team_employee, team_finance_admin, team_viewer

data. invitee_name · string · required

Minimum string length: 1

data. email · string<email> · required

data. inviter_name · string · required

Minimum string length: 1

data. inviter_email · string<email> · required

data. company · object

Show child attributes

data.company. name · string · required

Minimum string length: 1

data.company. avatar · string · required

data. team · object

Show child attributes

data.team. name · string · required

Minimum string length: 1

data.team. avatar · string · required