lists

Create a List

Create a list in Grata. The list visibility will be set to organization and it will be visible in the Grata UI for all users within the account to view.

post/api/v1.4/lists/

Request body

namestring required

Name of the list being created.

Example request

{
  "name": "New List"
}

Response

namestring required

Name of the list.

list_uidstring required

UID of the list.

created_datestring date-time required

Date the list was created.

updated_datestring date-time required

Date the list was last updated.

company_countinteger required

Number of companies in the list.

Example response

{
  "name": "List A",
  "list_uid": "QE5XDQEB",
  "created_date": "2024-05-13T16:25:17.065916Z",
  "updated_date": "2024-06-17T07:15:59.708119Z",
  "company_count": 3
}

Changes

Changed in 3 of the 5 revisions of this API.2618

Dec 4, 2024b36e8e329afb111See the full diff
- ▲
  the request property name became required
  request-property-became-required
- ○
  the endpoint scheme security ApiKeyAuth was removed from the API
  api-security-removed
- ○
  api tag lists added
  api-tag-added
- ○
  added the media type application/json for the response with the status 400
  response-media-type-added
- ○
  added the media type application/json for the response with the status 401
  response-media-type-added
- ○
  added the media type application/json for the response with the status 429
  response-media-type-added
- ○
  added the media type application/json for the response with the status 500
  response-media-type-added
- ○
  the response property company_count became required for the status 200
  response-property-became-required
- ○
  the response property created_date became required for the status 200
  response-property-became-required
- ○
  the response property list_uid became required for the status 200
  response-property-became-required
- ○
  the response property name became required for the status 200
  response-property-became-required
- ○
  the response property updated_date became required for the status 200
  response-property-became-required
This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 4, 2024f80fb2a115ff157See the full diff
- ▲
  request body became required
  request-body-became-required
- ●
  deleted the header request parameter Content-Type
  request-parameter-removed
- ●
  removed the optional property count from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property page from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property pages from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property results from the response with the 200 status
  response-optional-property-removed
- ○
  api operation id create removed and replaced with createList
  api-operation-id-removed
- ○
  the endpoint scheme security ApiKeyAuth was added to the API
  api-security-added
- ○
  added the optional property company_count to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property created_date to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property list_uid to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property updated_date to the response with the 200 status
  response-optional-property-added
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 4, 202429fbf7a6e1061See the full diff
- ●
  deleted the header request parameter Authorization
  request-parameter-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history