Organization

4 endpoints in this group. All paths are prefixed with /api/v1.

Endpoints in this group#

• GET /api/v1/organization — Get Organization
• PATCH /api/v1/organization — Update Organization
• GET /api/v1/organization/billing-address — Get Billing Address
• PATCH /api/v1/organization/billing-address — Update Billing Address

GET /api/v1/organization — Get Organization {#get-api-v1-organization}#

Parameters:

• authorization (header, string, optional)

Responses:

• 200 — Successful Response. Returns: ApiResponse_OrganizationResponse_ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

PATCH /api/v1/organization — Update Organization {#patch-api-v1-organization}#

Parameters:

• authorization (header, string, optional)

Body: OrganizationUpdateRequest — {name}

Responses:

• 200 — Successful Response. Returns: ApiResponse_OrganizationResponse_ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

GET /api/v1/organization/billing-address — Get Billing Address {#get-api-v1-organization-billing-address}#

Parameters:

• authorization (header, string, optional)

Responses:

• 200 — Successful Response. Returns: ApiResponse_BillingAddressResponse_ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

PATCH /api/v1/organization/billing-address — Update Billing Address {#patch-api-v1-organization-billing-address}#

Parameters:

• authorization (header, string, optional)

Body: BillingAddressUpdateRequest — {company_name, street, city, state + 3 more}

Responses:

• 200 — Successful Response. Returns: ApiResponse_BillingAddressResponse_ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}