Resource: Organisations ( /api/organisations )

Organisations (collection) resource

Root Relation: Organisations

Methods

GET

Retrieves a list of all organisations.

This method supports the OData parameters $filter, $top, $take, $orderby and $inlinecount. See OData Topic for more details.

Supported Expansions

• RelationshipTypes
• Projects
• ProjectCategories
• Statuses
• Priorities
• RequirementTypes
• RequirementStatuses
• RequirementDifficulties
• IncidentTypes
• TestTypes
• IncidentResolutions
• IncidentStatuses
• Versions
• Components

For more details on expansions, please see the Expand help topic.

Status Codes

These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

{
  "Items": [
    {
      "Name": "Acme Inc",
      "OrderNumber": 1,
      "ShortDescription": "Acme Inc make products",
      "LongDescription": "Acme Inc make products large and small, for many verticals and horizontals",
      "IndustryType": "Generics",
      "Expands": [
        "Components",
        "IncidentResolutions",
        "IncidentStatuses",
        "IncidentTypes",
        "Priorities",
        "ProjectCategories",
        "Projects",
        "RequirementDifficulties",
        "RequirementStatuses",
        "RequirementTypes",
        "Statuses",
        "TestTypes",
        "Versions"
      ],
      "Self": "http://localhost/api/organisation/a84de3d2-6b49-41c4-ad1d-c937338b0e31"
    }
  ]
}