tx-agent-kit
API Reference

organizations Endpoints

API endpoints for the organizations resource group

organizations Endpoints

GET /v1/organizations

Parameters

NameInTypeRequiredDescription
cursorquerystringNo---
limitquerystringNo---
sortByquerystringNo---
sortOrderquerystringNo---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/organizations

Responses

StatusDescription
201Success
400The request did not match the expected schema
401Unauthorized
404NotFound
409Conflict
429TooManyRequests
500InternalError

GET /v1/organizations/{organizationId}

Parameters

NameInTypeRequiredDescription
organizationIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
404NotFound
409Conflict
429TooManyRequests
500InternalError

PATCH /v1/organizations/{organizationId}

Parameters

NameInTypeRequiredDescription
organizationIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
404NotFound
409Conflict
429TooManyRequests
500InternalError

DELETE /v1/organizations/{organizationId}

Parameters

NameInTypeRequiredDescription
organizationIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/organizations/batch/get-many

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
404NotFound
409Conflict
429TooManyRequests
500InternalError

GET /v1/invitations

Parameters

NameInTypeRequiredDescription
cursorquerystringNo---
limitquerystringNo---
sortByquerystringNo---
sortOrderquerystringNo---
filter[status]querystringNo---
filter[role]querystringNo---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/invitations

Responses

StatusDescription
201Success
400The request did not match the expected schema
401Unauthorized
404NotFound
409Conflict
429TooManyRequests
500InternalError

GET /v1/invitations/{invitationId}

Parameters

NameInTypeRequiredDescription
invitationIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
404NotFound
409Conflict
429TooManyRequests
500InternalError

PATCH /v1/invitations/{invitationId}

Parameters

NameInTypeRequiredDescription
invitationIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
404NotFound
409Conflict
429TooManyRequests
500InternalError

DELETE /v1/invitations/{invitationId}

Parameters

NameInTypeRequiredDescription
invitationIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/invitations/batch/get-many

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/invitations/{token}/accept

Parameters

NameInTypeRequiredDescription
tokenpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
404NotFound
409Conflict
429TooManyRequests
500InternalError

On this page