Instance Organization Invites Actions

https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID/invites

Below are the various requests that can be performed against the Instance Organization Invites resource, as well as the expected parameters and the potential responses.

Get

Returns a collection of instance organization invites

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID/invites

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgInvites.*, or instanceOrgInvites.get.

Request Path Components

Path Component Description Example
INSTANCE_ID ID associated with the instance 575ec8687ae143cd83dc4a97
ORG_ID ID associated with the organization 575ec8687ae143cd83dc4a97

Request Query Parameters

Name Required Description Default Example
sortField N Field to sort the results by. Accepted values are: email, role, inviteDate inviteDate sortField=role
sortDirection N Direction to sort the results by. Accepted values are: asc, desc desc sortDirection=asc
filterField N Field to filter the results by. Blank or not provided means no filtering. Accepted values are: email, role filterField=email
filter N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. filter=my * instance

Request Headers

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Curl Example 

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID/invites

Successful Responses

Code Type Description
200 Instance Organization Invitations A collection of instance organization invitations

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if instance or organization was not found

Post

Invites a member to an instance organization

Method And Url

POST https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID/invites

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.User, instanceOrgInvites.*, or instanceOrgInvites.post.

Request Path Components

Path Component Description Example
INSTANCE_ID ID associated with the instance 575ec8687ae143cd83dc4a97
ORG_ID ID associated with the organization 575ec8687ae143cd83dc4a97

Request Headers

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Organization Invitation Post schema. For example, the following would be a valid body for this request:

{
  "email": "invitedUser@example.com",
  "role": "edit"
}

Curl Example 

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"email":"invitedUser@example.com","role":"edit"}' \
    https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID/invites

Successful Responses

Code Type Description
201 Instance Organization Invitations The new organization invite

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if instance or organization was not found

Was this page helpful?

Still looking for help? You can also search the Losant Forums or submit your question there.