Organisations

The Organisations API allows you to find specific organisations and retrieve lists of organisations from your account.

Find Organisation

QUERYorganisation

Retrieves details for a specific organisation by ID or name.

Arguments

Parameter	Type	Description
criteria	OrganisationLookupInput	Required Criteria for finding an organisation

OrganisationLookupInput

Field	Type	Description
id	ID	Optional ID of the organisation to find
name	String	Optional Name of the organisation to find

Example Query

query {
  viewer {
    organisation(criteria: {
      name: "Acme Group"
    }) {
      id
      name
      created
      updated
      monthlyCredits
      credits
      userLimits
      brands {
        id
        name
      }
    }
  }
}

Response

{
  "data": {
    "viewer": {
      "organisation": {
        "id": "T3JnYW5pc2F0aW9uOjU=",
        "name": "Acme Group",
        "created": "2024-01-15T10:30:00Z",
        "updated": "2024-02-20T15:45:12Z",
        "monthlyCredits": 1000,
        "credits": 750,
        "userLimits": 100,
        "brands": [
          {
            "id": "QnJhbmQ6MTA=",
            "name": "Acme Inc."
          },
          {
            "id": "QnJhbmQ6MTU=",
            "name": "Acme Partners"
          }
        ]
      }
    }
  }
}

List Organisations

QUERYorganisations

Retrieves a paginated and filterable list of organisations. Requires admin access.

Arguments

Parameter	Type	Description
filter	OrganisationListFilterInput	Required Filter and pagination options

OrganisationListFilterInput

Field	Type	Description
filter	String	Optional Search term to filter organisations by name
page	Int	Optional Page number for pagination (default: 1)
limit	Int	Optional Maximum number of organisations to return per page (default: 10)

Example Query

query {
  viewer {
    organisations(filter: {
      filter: "acme",
      page: 1,
      limit: 10
    }) {
      items {
        id
        name
        created
        monthlyCredits
        brands {
          id
          name
        }
      }
      total
      page
      limit
      pages
    }
  }
}

Response

{
  "data": {
    "viewer": {
      "organisations": {
        "items": [
          {
            "id": "T3JnYW5pc2F0aW9uOjU=",
            "name": "Acme Group",
            "created": "2024-01-15T10:30:00Z",
            "monthlyCredits": 1000,
            "brands": [
              {
                "id": "QnJhbmQ6MTA=",
                "name": "Acme Inc."
              },
              {
                "id": "QnJhbmQ6MTU=",
                "name": "Acme Partners"
              }
            ]
          },
          {
            "id": "T3JnYW5pc2F0aW9uOjc=",
            "name": "Acme Global",
            "created": "2024-02-05T09:15:30Z",
            "monthlyCredits": 2000,
            "brands": [
              {
                "id": "QnJhbmQ6MjA=",
                "name": "Acme International"
              }
            ]
          }
        ],
        "total": 2,
        "page": 1,
        "limit": 10,
        "pages": 1
      }
    }
  }
}

Organisation Fields

The Organisation object contains the following fields:

Field	Type	Description
id	ID	Unique identifier for the organisation
name	String	Name of the organisation
created	DateTime	Creation date of the organisation
updated	DateTime	Last update date of the organisation
monthlyCredits	Int	Monthly credits allocated to the organisation
credits	Int	Current available credits
userLimits	Int	Maximum number of users allowed for the organisation
brands	[Brand]	Brands associated with this organisation

Working with Organisations

Access Control

Access to organisation data is controlled by user permissions:

• Global administrators can access any organisation
• Organisation administrators can access their own organisation
• Regular users might not have direct access to organisation data

Organisational Structure

The SixtySeconds platform uses a hierarchical structure:

1. Organisations are at the top level and can contain multiple brands
2. Brands belong to organisations and can have multiple users
3. Users are associated with specific brands

This structure allows for efficient management of resources, permissions, and content across your business units.

Credits Management

Credits are managed at both the organisation and brand level:

• Organisation credits: Overall allocation of credits for all brands within the organisation
• Brand credits: Credits allocated to specific brands from the organisation's pool

Organisation administrators can redistribute credits among brands as needed.