Skip to main content

Fetch Organization

GET 
/v1/organization/:organization_id_or_slug

⚠️ WARNING

This endpoint is unstable & not officially supported. It may be deprecated and removed in future API versions.

Fetch Organization

Request​

Path Parameters

    organization_id_or_slug Organization Id Or Slugrequired

Query Parameters

    offset_number Offset Number

    Default value: 0

    limit any

Responses​

Successful Response

Schema

    anyOf

    plan_type OrganizationPlan (string)required

    Possible values: [atlas_demo, atlas_enterprise, atlas_team, atlas_plus, atlas_research, atlas_starter, atlas_startup, atlas_pro, mock, free_test_user, pro, enterprise, free, research]

    The plan type this organization is on.

    max_datums_per_project Max Datums Per Project (integer)required
    max_members Max Members (integer)required
    max_projects Max Projects (integer)required
    max_external_collaborators Max External Collaborators (integer)required

    max_datums_across_all_projects

    object

    anyOf

    integer

    private_projects Private Projects (boolean)
    max_free_embedding_api_token_usage Max Free Embedding Api Token Usage (integer)required

    max_storage

    object

    anyOf

    integer

    max_premium_api_calls

    object

    anyOf

    integer

    max_non_embedding_projects

    object

    anyOf

    integer

    features string[]required
    free_text_tokens_per_seat Free Text Tokens Per Seat (integer)

    Default value: 0

    free_image_embeddings_per_seat Free Image Embeddings Per Seat (integer)

    Default value: 0

    free_storage_per_seat Free Storage Per Seat (integer)

    Default value: 0

    free_seats Free Seats (integer)

    Default value: 0

    max_advanced_analysis_calls Max Advanced Analysis Calls (integer)

    Default value: 3

    max_advanced_analysis_calls_per_billing_period Max Advanced Analysis Calls Per Billing Period (integer)

    Default value: 0

    id Id (string)required

    Organization ID

    nickname Nickname (string)required

    The organization nickname

    projects

    object[]

    required

    All of the organization's projects the requested user can access

  • Array [

    • id Id (string)required

    Project ID

    owner Owner (string)required

    The organization ID that owns this project

    project_name Project Name (string)required

    The name of this project

    creator

    object

    The user id who created this project.

    anyOf

    string

    description Description (string)required

    A description for this project.

    is_public Is Public (boolean)required

    Is the project viewable without being in the organzation?

    is_public_to_org Is Public To Org (boolean)required

    Is the project viewable to the organization?

    privacy Privacy (string)required

    Possible values: [public, with_link, private, restricted]

    The privacy settings for who can view the project.

    project_fields string[]required

    The list of fields a datum in the project may contain.

    unique_id_field

    object

    DEPRECATED: A field that contains a unique id for each document.

    anyOf

    string

    modality

    object

    The project modality. DEPRECATED.

    anyOf

    string

    total_datums_in_project Total Datums In Project (integer)required

    Total datums in project.

    created_timestamp date-timerequired

    The timestamp this project was created.

    slug Slug (string)required

    The project url-safe slug

    connector_name

    object

    The connector name used to create this project

    anyOf

    string

    organization_slug Organization Slug (string)required

    The organization url-safe slug

    organization_name Organization Name (string)required

    The organization nickname

    creator_nickname

    object

    The creator nickname

    anyOf

    string

    creator_picture

    object

    required

    The creator picture

    anyOf

    string

    nickname

    object

    The nickname who created this project.

    anyOf

    string

    thumbnail Thumbnail (string)required

    The project display thumbnail.

  • ]

    • slug

    object

    required

    The organization url-safe slug

    anyOf

    string

    access_role AccessRole (string)

    Possible values: [OWNER, ADMIN, MEMBER, VIEWER, EXTERNAL, GUEST, NONE]

    Default value: VIEWER

    Access role of user for this organization

    permissions

    object

    required

    User permissions in organization

    property name* boolean
    public_organization Public Organization (boolean)required

    Is the organization public?

    description

    object

    A description for this organization.

    anyOf

    string

    Possible values: <= 512 characters

    stripe_subscription_id

    object

    required

    Stripe subscription id

    anyOf

    string

    stripe_customer_id

    object

    required

    Stripe subscription id

    anyOf

    string

    stripe_subscription_start_timestamp

    object

    required

    The timestamp the stripe subscription billing period starts

    anyOf

    string

    members

    object[]

    required

    All of the organization members with access roles.

  • Array [

    • picture

    object

    required

    The users profile image

    anyOf

    string

    organization_id Organization Id (string)required

    Organization ID

    nickname Nickname (string)required

    User nickname

    permissions

    object

    required

    User permissions in organization

    property name* boolean
    email Email (string)required

    User email

    user_id User Id (string)required

    Unique user id

    access_role Access Role (string)required

    User access role in organization

  • ]

    • stripe_subscription_end_timestamp

    object

    required

    The timestamp the stripe subscription billing period ends

    anyOf

    string

    stripe_trial_end_timestamp

    object

    required

    The timestamp the stripe trial period ends

    anyOf

    string

    project_count Project Count (integer)required

    The total number of projects of this organization

    connectors

    object[]

    required

    The connectors this organization has enabled

  • Array [

    • id Id (string)required
    connector_name Connector Name (string)required

    metadata

    object

    anyOf

    property name* any

    creation_params

    object

    required

    property name* any

    secrets

    object

    anyOf

    string

    created_timestamp Created Timestamp (string)required

    datasets

    object

    required

    data string[]required

    user_id

    object

    anyOf

    string

  • ]

    • ai_subprocessor Ai Subprocessor (string)required

    Possible values: [openai, aws-bedrock]

    The AI subprocessor for the organization.

    organization_type Organization Type (string)required

    The type of organization: personal, company and academic

    linked_user_account_id

    object

    required

    The user id of the linked account Atlas account to this organization. Null if there is no linked account.

    anyOf

    string

    time_created date-timerequired

    When this organization was created.

    logo_url

    object

    The url of the organization logo.

    anyOf

    string

    Possible values: <= 512 characters

    website

    object

    The url of the organization website.

    anyOf

    string

    Possible values: <= 255 characters

Loading...