affiliateOrganisations

Partner organisations within the viewer's authorised scope. Affiliate organisations are included, including those that also have API access and legacy organisations with no domain type. API-only organisations are excluded. A partner user receives only the organisation they belong to.

Arguments

after : String

before : String

first : Int

input : AffiliateOrganisationsInput

Filters for partner organisations. Omit to return every organisation in scope.

last : Int

Returns

AffiliateOrganisationConnectionTypeConnection

Paginator of partner organisations.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can query affiliate organisations

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query AffiliateOrganisations(
  $after: String,
  $before: String,
  $first: Int,
  $input: AffiliateOrganisationsInput,
  $last: Int
) {
  affiliateOrganisations(
    after: $after,
    before: $before,
    first: $first,
    input: $input,
    last: $last
  ) {
    edgeCount
    edges {
      ...AffiliateOrganisationConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "input": AffiliateOrganisationsInput,
  "last": 10
}

{
  "data": {
    "affiliateOrganisations": {
      "edgeCount": 1,
      "edges": [AffiliateOrganisationConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 23
    }
  }
}