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:
GET /organizations
user:organization:read
user_basic
Response: Paginated Array
id
- string: Organization Idname
- string: Organization namerole
- string: Role user who is calling the endpoint has within the organizationslug
- string: Organization slugExample
$ http GET 'http://localhost:5000/organizations?limit=2' 'Authorization: Bearer ACCESS_TOKEN'HTTP/1.1 200 OK{"cursor": "orgz_56ce2a2e-0864-411c-a4db-60ca221fd3f4","elements": [{"id": "orgz_64010772-1522-4c37-83ca-219ae906d843","name": "Test Org","role": "owner","slug": "test-org"},{"id": "orgz_56ce2a2e-0864-411c-a4db-60ca221fd3f4","name": "Test Org 2","role": "owner","slug": "test-org-2"}]}
Get information regarding a specific organization by using the slug. Can be called publicly without an access token.
GET /organizations/:slug
Response
Paginated Array
id
- string: Organization Idname
- string: Organization nameslug
- string: Organization slugExample
$ http GET 'http://localhost:5000/organizations/test-org'HTTP/1.1 200 OK{"id": "orgz_64010772-1522-4c37-83ca-219ae906d843","name": "Test Org","role": "OWNER","slug": "test-org"}
See Dashboard section