Retrieve an organization

Retrieving organization data is critical to being able to call the API with the correct organization slug. There's a couple of ways to go about it:

Endpoints

Get all organizations a user belongs to

• GET /organizations
  • Permissions: user:organization:read
  • Roles: user_basic

Response: Paginated Array

• id - string: Organization Id
• name - string: Organization name
• role - string: Role user who is calling the endpoint has within the organization
• slug - string: Organization slug

Example

1 $ http GET 'http://localhost:5000/organizations?limit=2' 'Authorization: Bearer ACCESS_TOKEN'
2 
3 HTTP/1.1 200 OK
4 {
5     "cursor": "orgz_56ce2a2e-0864-411c-a4db-60ca221fd3f4",
6     "elements": [
7         {
8             "id": "orgz_64010772-1522-4c37-83ca-219ae906d843",
9             "name": "Test Org",
10             "role": "owner",
11             "slug": "test-org"
12         },
13         {
14             "id": "orgz_56ce2a2e-0864-411c-a4db-60ca221fd3f4",
15             "name": "Test Org 2",
16             "role": "owner",
17             "slug": "test-org-2"
18         }
19     ]
20 }

Get information about a specific organization

Get information regarding a specific organization by using the slug. Can be called publicly without an access token.

• GET /organizations/:slug
  • Permissions: none

Response

Paginated Array

• id - string: Organization Id
• name - string: Organization name
• slug - string: Organization slug

Example

1 $ http GET 'http://localhost:5000/organizations/test-org'
2 
3 HTTP/1.1 200 OK
4 {
5     "id": "orgz_64010772-1522-4c37-83ca-219ae906d843",
6     "name": "Test Org",
7     "role": "OWNER",
8     "slug": "test-org"
9 }

Get organization data by calling the dashboard

See Dashboard section