List an organization's invitations
GET
/v1/backend/organizations/{organizationId}/invitations
const url = 'https://api.zautha.com/v1/backend/organizations/example/invitations';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.zautha.com/v1/backend/organizations/example/invitations \ --header 'Authorization: Bearer <token>'Newest first, 20 a page by default (limit 1-100); status (repeatable) keeps those statuses.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”organizationId
required
string
Query Parameters
Section titled “Query Parameters”limit
integer format: int32
offset
integer format: int32
status
Array<string>
Responses
Section titled “Responses”OK
Media typeapplication/json
object
data
required
Array<object>
object
id
required
string
object
required
string
email_address
required
string
role
required
string
role_name
required
string
status
required
public_organization_data
required
object
id
required
string
name
required
string
slug
required
null | string
inviter
required
public_metadata
required
object
private_metadata
required
object
redirect_url
required
null | string
url
required
null | string
expires_at
required
string format: date-time
created_at
required
string format: date-time
updated_at
required
string format: date-time
total_count
required
integer format: int32
Example
{ "data": [ { "status": "pending" } ]}The request is malformed, or a field is not valid (validation_failed names each one in errors).
Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
trace_id
required
string
reverification
object
level
required
string
after_minutes
required
integer format: int32
tasks
Array<string>
errors
Array<object>
object
field
required
string
code
required
string
message
required
string
Example
{ "code": "bad_request", "reverification": { "level": "first_factor" }, "tasks": [ "setup_mfa" ], "errors": [ { "code": "bad_request" } ]}The secret key is missing or not valid.
Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
trace_id
required
string
reverification
object
level
required
string
after_minutes
required
integer format: int32
tasks
Array<string>
errors
Array<object>
object
field
required
string
code
required
string
message
required
string
Example
{ "code": "bad_request", "reverification": { "level": "first_factor" }, "tasks": [ "setup_mfa" ], "errors": [ { "code": "bad_request" } ]}Not Found.
Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
trace_id
required
string
reverification
object
level
required
string
after_minutes
required
integer format: int32
tasks
Array<string>
errors
Array<object>
object
field
required
string
code
required
string
message
required
string
Example
{ "code": "bad_request", "reverification": { "level": "first_factor" }, "tasks": [ "setup_mfa" ], "errors": [ { "code": "bad_request" } ]}Too many requests with this secret key. Retry after the seconds in Retry-After.
Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
trace_id
required
string
reverification
object
level
required
string
after_minutes
required
integer format: int32
tasks
Array<string>
errors
Array<object>
object
field
required
string
code
required
string
message
required
string
Example
{ "code": "bad_request", "reverification": { "level": "first_factor" }, "tasks": [ "setup_mfa" ], "errors": [ { "code": "bad_request" } ]}Headers
Section titled “Headers”Retry-After
integer format: int32
Seconds to wait before retrying.
The service is temporarily unavailable. Try again shortly.
Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
trace_id
required
string
reverification
object
level
required
string
after_minutes
required
integer format: int32
tasks
Array<string>
errors
Array<object>
object
field
required
string
code
required
string
message
required
string
Example
{ "code": "bad_request", "reverification": { "level": "first_factor" }, "tasks": [ "setup_mfa" ], "errors": [ { "code": "bad_request" } ]}