Organizations

get
Authorizations
AuthorizationstringRequired
Query parameters
searchstringOptional

A search term.

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

Page number to retrieve (1-indexed).

page_sizeintegerOptional

Number of results per page. Defaults to the pagination class's page size and respects the configured maximum.

Responses
chevron-right
200Success
application/json
get
/organizations/
200Success
post
Authorizations
AuthorizationstringRequired
Body
namestring · min: 1Required
typestring · min: 1Required
domainstring | nullableOptional
websitestring | nullableOptional
industrystring | nullableOptional
company_sizeinteger | nullableOptional
locationstring | nullableOptional
descriptionstring | nullableOptional
Responses
post
/organizations/
201Success
get
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
chevron-right
200Success
application/json
get
/organizations/{id}/
200Success
put
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Body
namestring · min: 1 · max: 255Required
typestring · min: 1 · max: 100Required
Responses
chevron-right
200Success
application/json
put
/organizations/{id}/
200Success
delete
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
delete
/organizations/{id}/
204Success

No content

patch
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Body
namestring · min: 1 · max: 255Required
typestring · min: 1 · max: 100Required
Responses
chevron-right
200Success
application/json
patch
/organizations/{id}/
200Success

Last updated