Sign in
lists

Get a saved list

Changed on

Return a saved list with hydrated entries.

Use this saved-list operation to collect actors for a signed-in user's later review. Lists are personal workflow artifacts; exports should keep source counts or receipts attached to the actors they describe.

get/api/lists/{list_id}

Request

  • Base URL: https://atlas.rebuildingus.org
  • URL: https://atlas.rebuildingus.org/api/lists/{list_id}
  • Auth: none declared

Path parameters

list_idstring required

Headers

x-api-keystring nullable

Response

Successful Response

created_atstring required

created at for this saved list.

descriptionstring nullable

description for this saved list.

idstring required

id for this saved list.

item_countinteger

item count for this saved list.

namestring required

name for this saved list.

org_idstring nullable

org id for this saved list.

updated_atstring required

updated at for this saved list.

user_idstring required

user id for this saved list.

Changes

  • 6ea72ce93d40Revision changes
    • warning

      deleted the header request parameter x-atlas-actor-email

    • warning

      deleted the header request parameter x-atlas-actor-id

    • warning

      deleted the header request parameter x-atlas-internal-secret

    • warning

      deleted the header request parameter x-atlas-organization-id

  • 32bd078ed621Revision changes
    • info

      added the optional property ///// to the response with the status