Get an organization | Tradespace | Developer Documentation

query ExampleQuery($id: String!) {
  organization(id: $id) {
    archivedAt
    archivedByUser {
      avatarUrl
      contact
      createdAt
      email
      firstName
      fullName
      id
      lastName
      stateEnum
      updatedAt
    }
    billsCount
    commentsCount
    createdAt
    createdByUser {
      avatarUrl
      contact
      createdAt
      email
      firstName
      fullName
      id
      lastName
      stateEnum
      updatedAt
    }
    createdByUserId
    description
    domain
    email
  }
}

{
  "data": {
    "organization": {
      "archivedAt": "example",
      "archivedByUser": {
        "avatarUrl": "example",
        "contact": {
          "addressStateCode": null,
          "archivedAt": null,
          "archivedByUser": null,
          "contactAddresses": null,
          "contactCitizenships": null,
          "contactClassifications": null,
          "contactDetails": null,
          "contactOrganizations": null,
          "contactRoles": null,
          "country": null
        },
        "createdAt": "example",
        "email": "example",
        "firstName": "example",
        "fullName": "example",
        "id": "example",
        "lastName": "example",
        "stateEnum": "disabled",
        "updatedAt": "example"
      },
      "billsCount": 0,
      "commentsCount": 0,
      "createdAt": "example",
      "createdByUser": {
        "avatarUrl": "example",
        "contact": {
          "addressStateCode": null,
          "archivedAt": null,
          "archivedByUser": null,
          "contactAddresses": null,
          "contactCitizenships": null,
          "contactClassifications": null,
          "contactDetails": null,
          "contactOrganizations": null,
          "contactRoles": null,
          "country": null
        },
        "createdAt": "example",
        "email": "example",
        "firstName": "example",
        "fullName": "example",
        "id": "example",
        "lastName": "example",
        "stateEnum": "disabled",
        "updatedAt": "example"
      },
      "createdByUserId": "example",
      "description": "example",
      "domain": "example",
      "email": "example"
    }
  }
}

Returns an organization by ID.

Arguments

idStringRequired

The ID of the organization to return.

Returns

an Organization

createdAtString

The organization's creation date.

idString

The organization's unique identifier.

organizationAddresseslist of OrganizationAddresses

The organization's postal addresses.

organizationRelationshipslist of OrganizationRelationships

The relationship types the account has with the organization.

updatedAtString

The date the organization was last updated.

archivedAtStringOptional

The date the organization was archived. Returns null if the organization is active.

archivedByUserUserOptional

The user who archived the organization.

billsCountIntegerOptional

The number of bills from the organization.

commentsCountIntegerOptional

The number of comments on the organization.

createdByUserUserOptional

The user who created the organization.

createdByUserIdStringOptional

The unique identifier of the user who created the organization.

descriptionStringOptional

The organization's description.

domainStringOptional

The organization's primary web domain.

emailStringOptional

The organization's email address.

expensesCountIntegerOptional

The number of expenses attributed to the organization.

federalAgencyCodeStringOptional

The organization's federal agency code, used in iEdison reporting.

filingsCountIntegerOptional

The number of filings linked to the organization.

hqCountryCodeStringOptional

The ISO 3166-1 alpha-2 country code of the organization’s headquarters.

invoicesCountIntegerOptional

The number of invoices sent to the organization.

legalNameStringOptional

The organization's registered legal name.

logoUrlStringOptional

The URL of the organization's logo.

nameStringOptional

The organization's name.

paymentDueDaysIntegerOptional

The organization's default payment terms in days.

paymentsCountIntegerOptional

The number of payments involving the organization.

phoneNumberStringOptional

The organization's phone number.

receivablesCountIntegerOptional

The number of receivables from the organization.

taxIdNumberStringOptional

The organization's tax identification number.

totalAmountPaidDoubleOptional

The total amount paid by the organization.

typeEnumOrganizationTypeEnumOptional

The organization's type.

Allowed values:

updatedByUserUserOptional

The user who last updated the organization.

updatedByUserIdStringOptional

The unique identifier of the user who last updated the organization.

websiteStringOptional

The organization's website URL.