Structured Sections

List Structured Sections

get/api/v1/structured_sections

Request

  • Base URL
    https://your-subdomain.pinpointhq.com
  • URL
    https://your-subdomain.pinpointhq.com/api/v1/structured_sections
  • Auth
    API key in header X-API-KEY

Query parameters

includestring[]

Structured Section relationships available for inclusion

Include related resources

fields[structured_sections]StructuredSectionsReadableAttribute[]

Structured Section readable attributes list

Include only specified fields of Structured Section in response

fields[questions]QuestionsReadableAttribute[]

Question readable attributes list

Include only specified fields of Question in response

filter[created_at][gt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with created_at greater than this value

filter[created_at][lt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with created_at less than this value

filter[updated_at][gt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with updated_at greater than this value

filter[updated_at][lt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with updated_at less than this value

sortstring[]

Structured Section sortable attributes

Sort records according to one or more criteria

You should not include both ascending id and descending -id fields the same time

page[number]integer
Example:1

The page number of records to return

page[size]integer

The number of records to return

stats[total]'count'
Example:count

Include the total number of matched records within the meta key of the response object.

Response

OK: Structured Sections collection

Changes

No recorded changes to this operation across all 1 revision of this API.