Qodex.ai

List grants

GET {{baseUrl}}/v3/grants

Lists grants for Connector

Request Params

KeyDatatypeRequiredDescription
limitnumberLimit the number of grant results
offsetnumberOffset grant results
sort_bystringSort entries by field name
order_bystringSpecify ascending or descending order
sincestringScope grants from a specific point in time by created_at
beforestringScope grants to a specific point in time by created_at
emailstringFiltering your query based on grant email address (if applicable)
grant_statusstringFiltering your query based on grant email status (if applicable)
ipstringFiltering your query based on grant IP address
providerstringOAuth provider

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"request_id":"\u003cstring\u003e","data":[{"id":"\u003cstring\u003e","provider":"\u003cstring\u003e","scope":["\u003cstring\u003e","\u003cstring\u003e"],"created_at":"\u003cinteger\u003e","grant_status":"\u003cstring\u003e","email":"\u003cstring\u003e","user_agent":"\u003cstring\u003e","ip":"\u003cstring\u003e","state":"\u003cstring\u003e","updated_at":"\u003cinteger\u003e"},{"id":"\u003cstring\u003e","provider":"\u003cstring\u003e","scope":["\u003cstring\u003e","\u003cstring\u003e"],"created_at":"\u003cinteger\u003e","grant_status":"\u003cstring\u003e","email":"\u003cstring\u003e","user_agent":"\u003cstring\u003e","ip":"\u003cstring\u003e","state":"\u003cstring\u003e","updated_at":"\u003cinteger\u003e"}],"limit":"\u003cinteger\u003e","offset":"\u003cinteger\u003e"}