List citations
Retrieve previous verification records with pagination and optional thread filtering.
/api/v1/citationshttps://api.webcite.coWhen to use it
Start with page=1&limit=20. The pagination schema allows a maximum of 100, while the controller description still says 50. Use 50 or fewer for compatibility. fields defaults to all; request basic explicitly for a smaller response.
Request
1 credit.
Examples run on your server. Set WEBCITE_API_KEY first. Python examples use the requests package.
curl --fail-with-body -X GET 'https://api.webcite.co/api/v1/citations' \
-H "x-api-key: $WEBCITE_API_KEY"Path and query parameters
page (query)numberPage number (starts at 1)
Default: 1
limit (query)numberResults per page (max 50)
Default: 20
fields (query)stringPredefined field set to return
Values: "minimal""basic""detailed""with_relations""all"
Default: "all"
thread_id (query)stringFilter by thread ID
No request body is required.
Response
Returns data and pagination metadata as defined below. Use the returned pagination values when requesting the next page.
200 response
application/json
dataobject[]requiredArray of citation records
Show data fields
api_key_idstringAPI key ID used for this citation
citationobjectCitation data (JSON string or array of CitationObject)
created_atstringTimestamp when the citation was created
idstringrequiredUnique identifier of the citation record
is_activebooleanWhether the citation is active
promptstringrequiredThe original prompt that generated this citation
thread_idstringrequiredThread ID associated with this citation
updated_atstringTimestamp when the citation was last updated
user_idstringUser ID who created this citation
messagestringrequiredResponse message
paginationobjectrequiredPagination metadata
Show pagination fields
hasNextPagebooleanrequiredWhether there is a next page
hasPreviousPagebooleanrequiredWhether there is a previous page
limitnumberrequiredNumber of items per page
pagenumberrequiredCurrent page number
totalnumberrequiredTotal number of items
totalPagesnumberrequiredTotal number of pages
statusCodenumberrequiredHTTP status code
Errors
For 400, check the request fields and source identifiers. For 401, check your API key. For 429, wait for the retry interval. See the errors guide before retrying a billable request.
401- Unauthorized - API key required