> ## Documentation Index
> Fetch the complete documentation index at: https://www.text.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Get account settings for an organization
> This HTTP endpoint allows you to retrieve a list of account organization settings.
These settings are tailored to each organization, providing customized configurations for their accounts.
For global settings, you can use the `/accounts` endpoint.
The `account_id` parameter is interchangeable with `me`, the `organization_id` parameter is interchangeable with `my`. The values will be sourced from authorization in such cases.
**Required scopes:** `accounts--my:ro`, `accounts--all:ro`
## OpenAPI
````yaml /api/global-accounts/openapi.json get /accounts/{account_id}/organization_settings/{organization_id}
openapi: 3.0.0
info:
title: Global Accounts API
description: >-
API used to manage Organizations and Accounts for multiple products. Also
responsible for authorization and authentication processes.
version: 2.0.0
servers:
- url: https://accounts.livechat.com/v2
description: Main production server URL
security: []
paths:
/accounts/{account_id}/organization_settings/{organization_id}:
get:
tags:
- AccountOrganizationSettings
summary: Get account settings for an organization
description: >-
This HTTP endpoint allows you to retrieve a list of account organization
settings.
These settings are tailored to each organization, providing customized
configurations for their accounts.
For global settings, you can use the `/accounts` endpoint.
The `account_id` parameter is interchangeable with `me`, the
`organization_id` parameter is interchangeable with `my`. The values
will be sourced from authorization in such cases.
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid4
default: me
- name: organization_id
in: path
required: true
schema:
type: string
format: uuid4
default: my
responses:
'200':
description: Object with account properties specific for a given organization.
content:
application/json:
schema:
type: object
properties:
avatar_url:
type: string
format: url
nullable: true
example:
avatar_url: >-
https://api.text.com/file/accounts/avatars/b2185556-634c-4ecf-b4c9-bcf8b65bc853/ae5bd37f-64b2-416b-bbb3-4623f53e6fb8/37a190dd-77a5-4fba-a7d3-2e89eab0e8fd.jpg
'401':
description: Unauthorized, missing, or invalid authorization.
content:
application/json:
schema:
allOf:
- description: The default error object.
type: object
properties:
error:
description: The error code.
type: string
enum:
- bad_request
- invalid_request
- unauthorized_client
- unauthorized
- access_denied
- unsupported_response_type
- invalid_scope
- server_error
- temporarily_unavailable
- unsupported_grant_type
- invalid_grant
- invalid_client
- conflict
- resource_not_found
- join_link_expired
- traffic_blocked
- not_implemented
error_description:
type: string
sub_error:
description: The error subcode.
type: string
nullable: true
request_id:
description: Unique request identifier.
type: string
format: uuid
- type: object
properties:
error:
type: string
error_description:
type: string
example:
error: unauthorized
error_description: The account is not authorized.
request_id: 5903c51b-89f0-41a9-a25d-4f39af100353
'403':
description: 'Forbidden: Insufficient scope.'
content:
application/json:
schema:
allOf:
- description: The default error object.
type: object
properties:
error:
description: The error code.
type: string
enum:
- bad_request
- invalid_request
- unauthorized_client
- unauthorized
- access_denied
- unsupported_response_type
- invalid_scope
- server_error
- temporarily_unavailable
- unsupported_grant_type
- invalid_grant
- invalid_client
- conflict
- resource_not_found
- join_link_expired
- traffic_blocked
- not_implemented
error_description:
type: string
sub_error:
description: The error subcode.
type: string
nullable: true
request_id:
description: Unique request identifier.
type: string
format: uuid
- type: object
properties:
error:
type: string
sub_error:
type: string
error_description:
type: string
example:
error: access_denied
sub_error: insufficient_scope
error_description: The resource owner or authorization server denied the request.
request_id: 5903c51b-89f0-41a9-a25d-4f39af100353
'404':
description: Resource not found.
content:
application/json:
schema:
allOf:
- description: Returned on validation errors.
allOf:
- description: The default error object.
type: object
properties:
error:
description: The error code.
type: string
enum:
- bad_request
- invalid_request
- unauthorized_client
- unauthorized
- access_denied
- unsupported_response_type
- invalid_scope
- server_error
- temporarily_unavailable
- unsupported_grant_type
- invalid_grant
- invalid_client
- conflict
- resource_not_found
- join_link_expired
- traffic_blocked
- not_implemented
error_description:
type: string
sub_error:
description: The error subcode.
type: string
nullable: true
request_id:
description: Unique request identifier.
type: string
format: uuid
- type: object
properties:
resource_name:
description: The name of the resource related to the error.
type: string
resource_id:
description: >-
The identifier of the resource related to the
error.
type: string
- type: object
properties:
error:
type: string
error_description:
type: string
example:
error: resource_not_found
error_description: The requested resource couldn't be found.
resource_name: account
resource_id: def31e95-5ca4-4817-b176-732e4544daca
request_id: 5903c51b-89f0-41a9-a25d-4f39af100353
'422':
description: Validation error.
content:
application/json:
schema:
allOf:
- description: The default error object.
type: object
properties:
error:
description: The error code.
type: string
enum:
- bad_request
- invalid_request
- unauthorized_client
- unauthorized
- access_denied
- unsupported_response_type
- invalid_scope
- server_error
- temporarily_unavailable
- unsupported_grant_type
- invalid_grant
- invalid_client
- conflict
- resource_not_found
- join_link_expired
- traffic_blocked
- not_implemented
error_description:
type: string
sub_error:
description: The error subcode.
type: string
nullable: true
request_id:
description: Unique request identifier.
type: string
format: uuid
- type: object
properties:
error:
type: string
error_description:
type: string
invalid_fields:
type: object
additionalProperties:
type: string
example:
error: invalid_request
error_description: >-
The request is missing a required parameter, includes an
invalid parameter value, includes a parameter more than once,
or is otherwise malformed.
invalid_fields:
email: invalid email address
request_id: 5903c51b-89f0-41a9-a25d-4f39af100353
'500':
description: Server Error.
content:
application/json:
schema:
allOf:
- description: The default error object.
type: object
properties:
error:
description: The error code.
type: string
enum:
- bad_request
- invalid_request
- unauthorized_client
- unauthorized
- access_denied
- unsupported_response_type
- invalid_scope
- server_error
- temporarily_unavailable
- unsupported_grant_type
- invalid_grant
- invalid_client
- conflict
- resource_not_found
- join_link_expired
- traffic_blocked
- not_implemented
error_description:
type: string
sub_error:
description: The error subcode.
type: string
nullable: true
request_id:
description: Unique request identifier.
type: string
format: uuid
- type: object
properties:
error:
type: string
error_description:
type: string
example:
error: server_error
error_description: >-
The server encountered an unexpected condition that prevented
it from fulfilling the request.
request_id: 5903c51b-89f0-41a9-a25d-4f39af100353
security:
- PersonalAccessToken: []
- OAuth2BearerToken:
- accounts--my:ro
- accounts--all:ro
components:
securitySchemes:
PersonalAccessToken:
description: >-
Use your `account ID` as the username and your personal access token
(PAT) as the password, or pass a Base64-encoded value directly in the
Authorization header. For more information, see the personal access tokens
guide.
type: http
scheme: basic
OAuth2BearerToken:
description: >-
This API uses OAuth2 with the implicit grant flow. Learn about
the implicit grant flow.
type: oauth2
flows:
implicit:
authorizationUrl: https://accounts.livechat.com
scopes: {}
authorizationCode:
authorizationUrl: https://accounts.livechat.com
tokenUrl: https://accounts.livechat.com/token
scopes: {}
````