--- title: "Retrieves a collection of New Relic accounts." method: GET path: "/newrelic-accounts" tags: ["New Relic Accounts"] --- # Retrieves a collection of New Relic accounts. `GET /newrelic-accounts` ## Request - Base URL: `https://api.acquia.com/v3` - URL: `https://api.acquia.com/v3/newrelic-accounts` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Query parameters - `offset` integer - `limit` integer - `filter` string ## Response `200` OK - object - `_links` object, required: HAL links for the resource - `self` NewRelicProvisioningAPIHalLink, required: HAL link object - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` boolean: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `prev` NewRelicProvisioningAPIHalLink: HAL link object - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` boolean: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `next` NewRelicProvisioningAPIHalLink: HAL link object - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` boolean: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `offset` object: Templated link for offset - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` true, required: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `limit` object: Templated link for limit - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` true, required: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `filter` object: Templated link for filtering. The `filter` query parameter is a string to signify the fields to filter the result set by. If the filter includes logical filters this string will be delimited by a "," for a logical OR filter, or a ";" for logical AND filters. Note: Only one type logical filter will be accepted. If the filter contains both OR and AND filters it will be rejected. (e.g. filter=field=value*;field2=value2* indicates that the result set will be filtered by "field" using the term "value*" AND "field2" using the term "value2*". Note that * is a wildcard character in this context). Allowed filter operators are: Equals: = (%3D), Does not equal: != (!%3D), Greater than: > (%3E), Less than: < (%3C), Greater than or equal to: >= (%3E%3D), Less than or equal to: <= (%3C%3D), Contains substring: =@ (%3D@), Does not contain substring: !@ (!@) - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` true, required: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `_embedded` object, required: Embedded resources for the collection - `items` object[], required: The array of resources in the collection - `entitlement_id` string, required: Acquia entitlement UUID for this New Relic account. - `subscription_id` string, required: Acquia subscription UUID associated with this entitlement. - `nr_account_id` string: New Relic account ID; absent until provisioning completes. - `status` 'provisioning' | 'active' | 'deprovisioning' | 'cancelled' | 'transferred-out' | 'failed', required: Lifecycle state of the New Relic account: provisioning — creation in progress; active — fully provisioned, NR account and admin invite issued; deprovisioning — cancellation in progress; cancelled — account cancelled, row retained for audit; transferred-out — account transferred out of Acquia parent, not cancelled by this service; failed — a step failed, re-trigger via a new broker event or ops tooling. - `created_at` string, date-time, required: Timestamp when the provisioning record was created. - `_links` object, required: HAL links for the resource - `self` NewRelicProvisioningAPIHalLink, required: HAL link object - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` boolean: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `_embedded` object: Embedded resources (optional) - `count` integer, required: The number of items in the current page - `total` integer, required: The total number of items available - `pagination` object, required - `total` integer, required: The total number of items available - `limit` integer, required: The maximum number of items to retrieve in a single page - `offset` integer, required: The starting position of the items to retrieve ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `500`: Internal Server Error --- [API](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api.md) - [All operations](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/revisions/508f8f94456d?raw)