customer-identity.api.skyflow.com
Open in
urlscan Pro
54.162.197.10
Public Scan
URL:
https://customer-identity.api.skyflow.com/
Submission: On September 30 via automatic, source certstream-suspicious — Scanned from DE
Submission: On September 30 via automatic, source certstream-suspicious — Scanned from DE
Form analysis
0 forms found in the DOMText Content
* Authentication * Contacts * getBulk Get Contacts * delBulk Delete Contacts * postInsert Contacts * getGet Contacts * delDelete Contacts * putUpdate Contacts * Identifiers * getBulk Get Identifiers * delBulk Delete Identifiers * postInsert Identifiers * getGet Identifiers * delDelete Identifiers * putUpdate Identifiers * Organizations * getBulk Get Organizations * delBulk Delete Organizations * postInsert Organizations * getGet Organizations * delDelete Organizations * putUpdate Organizations * Persons * getBulk Get Persons * delBulk Delete Persons * postInsert Persons * getGet Persons * delDelete Persons * putUpdate Persons * Query * postQuery Record * Tokens * getBulk Get Record By Tokens * getGet Record By Token Documentation Powered by ReDoc SKYFLOW (V1) Skyflow: support@skyflow.com URL: https://www.skyflow.com/ More about Skyflow AUTHENTICATION BEARER Access token, prefixed by Bearer: Bearer <token>. Retrieved using Management > Authentication Security Scheme Type API Key Header parameter name: Authorization CONTACTS BULK GET CONTACTS Gets records matching the ID's AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string QUERY PARAMETERS skyflow_ids Array of strings List of Record IDs who's objects needs to be fetched. If not present, then all records will be fetched based on offset, limit and ordered by skyflow_id. dlp string Default: "DEFAULT" Enum: "DEFAULT" "PLAIN_TEXT" "TOKEN" DLP to enforce on the data in response.. fields Array of strings Fields that needs to be fetched for the given Record IDs. If not specified, all fields would be fetched.. offset string <int64> Default: "0" Pagination Offset. - indicates the record number to start retrieving data. Not applicable for Token DLP View. limit string <int64> Default: "100" Pagination Limit. - indicates the number of records to retrieve. Not applicable for Token DLP View. RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response get/v1/vaults/{vaultID}/contacts https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/contacts REQUEST SAMPLES * curl Copy curl -i -X GET \ 'https:///%7Borg-name%7D.%7Baccount-name%7D.vault.skyflowapis.com/v1/vaults/:vaultID/contacts?skyflow_ids=string&dlp=DEFAULT&fields=string&offset=0&limit=100' \ -H 'Authorization: YOUR_API_KEY_HERE' RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "records": [ * { * "fields": { * "emails": [ * { * "value": "tjanuszewski0@ucoz.ru", * "type": "TEMP" } ], * "phone_numbers": [ * { * "value": "62(633)145-1699", * "type": "HOME" } ], * "social_media_handles": [ * { * "type": "Reddit", * "value": "tjahnel0" } ], * "addresses": [ * { * "full_name": "Crosby Berks", * "use": "TEMPORARY", * "line_1": "5233 Erie Parkway", * "line_2": "3 Arapahoe Pass", * "city": "Chapultepec", * "district": "Georgiyevka", * "country": "GUADELOUPE", * "zip_code": "88102", * "address_type": "BOTH" } ], * "website": "http://cornell.edu/donec/posuere/metus/vitae/ipsum.js", * "name": { * "prefix": "Mrs", * "first_name": "Sharia", * "middle_name": "Nalani", * "last_name": "Lapping", * "use": "NICKNAME", * "suffix": "Sr" }, * "gender": "OTHER", * "relationship": "FATHER", * "period": { * "start_date": "2012-09-09", * "end_date": "2019-03-21" }, * "is_emergency_contact": "FALSE" } } ] } BULK DELETE CONTACTS Deletes records matching the ID's or all records if '*' is provided as the ID AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string REQUEST BODY SCHEMA: APPLICATION/JSON vaultID string (Vault ID Under from which these records needs to be deleted) skyflow_ids Array of strings (List of Record IDs that needs to be deleted or '*' if all records under contacts needs to be deleted) RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response delete/v1/vaults/{vaultID}/contacts https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/contacts REQUEST SAMPLES * Payload * curl Content type application/json Copy Expand all Collapse all { * "vaultID": "string", * "skyflow_ids": [ * "string" ] } RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "RecordIDResponse": [ * "string" ] } INSERT CONTACTS Creates a Record for the given Vault ID & contacts AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string REQUEST BODY SCHEMA: APPLICATION/JSON vaultID string (Vault ID for contacts) records Array of objects (The list of records) RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response post/v1/vaults/{vaultID}/contacts https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/contacts REQUEST SAMPLES * Payload * curl Content type application/json Copy Expand all Collapse all { * "records": [ * { * "fields": { * "emails": [ * { * "value": "tjanuszewski0@ucoz.ru", * "type": "TEMP" } ], * "phone_numbers": [ * { * "value": "62(633)145-1699", * "type": "HOME" } ], * "social_media_handles": [ * { * "type": "Reddit", * "value": "tjahnel0" } ], * "addresses": [ * { * "full_name": "Crosby Berks", * "use": "TEMPORARY", * "line_1": "5233 Erie Parkway", * "line_2": "3 Arapahoe Pass", * "city": "Chapultepec", * "district": "Georgiyevka", * "country": "GUADELOUPE", * "zip_code": "88102", * "address_type": "BOTH" } ], * "website": "http://cornell.edu/donec/posuere/metus/vitae/ipsum.js", * "name": { * "prefix": "Mrs", * "first_name": "Sharia", * "middle_name": "Nalani", * "last_name": "Lapping", * "use": "NICKNAME", * "suffix": "Sr" }, * "gender": "OTHER", * "relationship": "FATHER", * "period": { * "start_date": "2012-09-09", * "end_date": "2019-03-21" }, * "is_emergency_contact": "FALSE" } } ] } RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "records": [ * { * "skyflow_id": "ae7k43l4-596f-189a-lj45-mk3l3e79df71md", * "createdTime": "2017-07-21T00:56:36.000Z" }, * { * "skyflow_id": "lak49d832-35hj-fhu4-f789-degl3ey6dfdsfb", * "createdTime": "2017-07-21T00:56:36.000Z" } ] } GET CONTACTS Retrieves a Record by using Row ID of a contacts AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string ID required string QUERY PARAMETERS dlp string Default: "DEFAULT" Enum: "DEFAULT" "PLAIN_TEXT" "TOKEN" DLP to enforce on the data in response. fields Array of strings Fields that needs to be fetched for the given Record ID. If not specified, all fields would be fetched. RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response get/v1/vaults/{vaultID}/contacts/{ID} https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/contacts/{ID} REQUEST SAMPLES * curl Copy curl -i -X GET \ 'https:///%7Borg-name%7D.%7Baccount-name%7D.vault.skyflowapis.com/v1/vaults/:vaultID/contacts/:ID?dlp=DEFAULT&fields=string' \ -H 'Authorization: YOUR_API_KEY_HERE' RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "fields": { * "skyflow_id": "string", * "emails": [ * { * "value": "string", * "type": "UNSPECIFIED_TYPE" } ], * "website": "string", * "phone_numbers": [ * { * "value": "string", * "type": "UNSPECIFIED_TYPE" } ], * "social_media_handles": [ * { * "type": "string", * "value": "string" } ], * "name": { * "prefix": "string", * "first_name": "string", * "middle_name": "string", * "last_name": "string", * "use": "UNSPECIFIED_USE", * "suffix": "string" }, * "addresses": [ * { * "full_name": "string", * "use": "UNSPECIFIED_USE", * "line_1": "string", * "line_2": "string", * "latitude": 0, * "longitude": 0, * "city": "string", * "district": "string", * "country": "UNSPECIFIED_COUNTRY", * "state": "string", * "zip_code": "string", * "address_type": "UNSPECIFIED_ADDRESS_TYPE" } ], * "gender": "UNSPECIFIED", * "relationship": "UNKNOWN_RELATION", * "period": { * "start_date": "string", * "end_date": "string" }, * "is_emergency_contact": "UNKNOWN_BOOL_VALUE", * "organizations_skyflow_id": [ * "string" ] } } DELETE CONTACTS Deletes the object by ID for the given contacts AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string ID required string RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response delete/v1/vaults/{vaultID}/contacts/{ID} https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/contacts/{ID} REQUEST SAMPLES * curl Copy curl -i -X DELETE \ https:///%7Borg-name%7D.%7Baccount-name%7D.vault.skyflowapis.com/v1/vaults/:vaultID/contacts/:ID \ -H 'Authorization: YOUR_API_KEY_HERE' RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "skyflow_id": "string", * "deleted": true } UPDATE CONTACTS Updates a Record for the given record ID , Vault ID & contacts AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string ID required string REQUEST BODY SCHEMA: APPLICATION/JSON ID string (ID of the Record to Fetch) vaultID string (Vault ID Under for this record) record object (skyflowcontactsRecords) RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response put/v1/vaults/{vaultID}/contacts/{ID} https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/contacts/{ID} REQUEST SAMPLES * Payload * curl Content type application/json Copy Expand all Collapse all { * "record": { * "fields": { * "emails": [ * { * "value": "tjanuszewski0@ucoz.ru", * "type": "TEMP" } ], * "phone_numbers": [ * { * "value": "62(633)145-1699", * "type": "HOME" } ], * "social_media_handles": [ * { * "type": "Reddit", * "value": "tjahnel0" } ], * "addresses": [ * { * "full_name": "Crosby Berks", * "use": "TEMPORARY", * "line_1": "5233 Erie Parkway", * "line_2": "3 Arapahoe Pass", * "city": "Chapultepec", * "district": "Georgiyevka", * "country": "GUADELOUPE", * "zip_code": "88102", * "address_type": "BOTH" } ], * "website": "http://cornell.edu/donec/posuere/metus/vitae/ipsum.js", * "name": { * "prefix": "Mrs", * "first_name": "Sharia", * "middle_name": "Nalani", * "last_name": "Lapping", * "use": "NICKNAME", * "suffix": "Sr" }, * "gender": "OTHER", * "relationship": "FATHER", * "period": { * "start_date": "2012-09-09", * "end_date": "2019-03-21" }, * "is_emergency_contact": "FALSE" } } } RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "skyflow_id": "ae7k43l4-596f-189a-lj45-mk3l3e79df71md", * "updatedTime": "2017-07-21T00:56:36.000Z" } IDENTIFIERS BULK GET IDENTIFIERS Gets records matching the ID's AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string QUERY PARAMETERS skyflow_ids Array of strings List of Record IDs who's objects needs to be fetched. If not present, then all records will be fetched based on offset, limit and ordered by skyflow_id. dlp string Default: "DEFAULT" Enum: "DEFAULT" "PLAIN_TEXT" "TOKEN" DLP to enforce on the data in response.. fields Array of strings Fields that needs to be fetched for the given Record IDs. If not specified, all fields would be fetched.. offset string <int64> Default: "0" Pagination Offset. - indicates the record number to start retrieving data. Not applicable for Token DLP View. limit string <int64> Default: "100" Pagination Limit. - indicates the number of records to retrieve. Not applicable for Token DLP View. RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response get/v1/vaults/{vaultID}/identifiers https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/identifiers REQUEST SAMPLES * curl Copy curl -i -X GET \ 'https:///%7Borg-name%7D.%7Baccount-name%7D.vault.skyflowapis.com/v1/vaults/:vaultID/identifiers?skyflow_ids=string&dlp=DEFAULT&fields=string&offset=0&limit=100' \ -H 'Authorization: YOUR_API_KEY_HERE' RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "records": [ * { * "fields": { * "ssn": "837-27-1663", * "drivers_license": [ * "R3708238", * "X9215829" ], * "itin": "965-29-7884", * "passport_number": "52616224" } } ] } BULK DELETE IDENTIFIERS Deletes records matching the ID's or all records if '*' is provided as the ID AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string REQUEST BODY SCHEMA: APPLICATION/JSON vaultID string (Vault ID Under from which these records needs to be deleted) skyflow_ids Array of strings (List of Record IDs that needs to be deleted or '*' if all records under identifiers needs to be deleted) RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response delete/v1/vaults/{vaultID}/identifiers https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/identifiers REQUEST SAMPLES * Payload * curl Content type application/json Copy Expand all Collapse all { * "vaultID": "string", * "skyflow_ids": [ * "string" ] } RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "RecordIDResponse": [ * "string" ] } INSERT IDENTIFIERS Creates a Record for the given Vault ID & identifiers AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string REQUEST BODY SCHEMA: APPLICATION/JSON vaultID string (Vault ID for identifiers) records Array of objects (The list of records) RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response post/v1/vaults/{vaultID}/identifiers https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/identifiers REQUEST SAMPLES * Payload * curl Content type application/json Copy Expand all Collapse all { * "records": [ * { * "fields": { * "ssn": "837-27-1663", * "drivers_license": [ * "R3708238", * "X9215829" ], * "itin": "965-29-7884", * "passport_number": "52616224" } } ] } RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "records": [ * { * "skyflow_id": "ae7k43l4-596f-189a-lj45-mk3l3e79df71md", * "createdTime": "2017-07-21T00:56:36.000Z" }, * { * "skyflow_id": "lak49d832-35hj-fhu4-f789-degl3ey6dfdsfb", * "createdTime": "2017-07-21T00:56:36.000Z" } ] } GET IDENTIFIERS Retrieves a Record by using Row ID of a identifiers AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string ID required string QUERY PARAMETERS dlp string Default: "DEFAULT" Enum: "DEFAULT" "PLAIN_TEXT" "TOKEN" DLP to enforce on the data in response. fields Array of strings Fields that needs to be fetched for the given Record ID. If not specified, all fields would be fetched. RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response get/v1/vaults/{vaultID}/identifiers/{ID} https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/identifiers/{ID} REQUEST SAMPLES * curl Copy curl -i -X GET \ 'https:///%7Borg-name%7D.%7Baccount-name%7D.vault.skyflowapis.com/v1/vaults/:vaultID/identifiers/:ID?dlp=DEFAULT&fields=string' \ -H 'Authorization: YOUR_API_KEY_HERE' RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "fields": { * "skyflow_id": "string", * "ssn": "string", * "drivers_license": [ * "string" ], * "itin": "string", * "passport_number": "string" } } DELETE IDENTIFIERS Deletes the object by ID for the given identifiers AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string ID required string RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response delete/v1/vaults/{vaultID}/identifiers/{ID} https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/identifiers/{ID} REQUEST SAMPLES * curl Copy curl -i -X DELETE \ https:///%7Borg-name%7D.%7Baccount-name%7D.vault.skyflowapis.com/v1/vaults/:vaultID/identifiers/:ID \ -H 'Authorization: YOUR_API_KEY_HERE' RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "skyflow_id": "string", * "deleted": true } UPDATE IDENTIFIERS Updates a Record for the given record ID , Vault ID & identifiers AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string ID required string REQUEST BODY SCHEMA: APPLICATION/JSON ID string (ID of the Record to Fetch) vaultID string (Vault ID Under for this record) record object (skyflowidentifiersRecords) RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response put/v1/vaults/{vaultID}/identifiers/{ID} https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/identifiers/{ID} REQUEST SAMPLES * Payload * curl Content type application/json Copy Expand all Collapse all { * "record": { * "fields": { * "ssn": "837-27-1663", * "drivers_license": [ * "R3708238", * "X9215829" ], * "itin": "965-29-7884", * "passport_number": "52616224" } } } RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "skyflow_id": "ae7k43l4-596f-189a-lj45-mk3l3e79df71md", * "updatedTime": "2017-07-21T00:56:36.000Z" } ORGANIZATIONS BULK GET ORGANIZATIONS Gets records matching the ID's AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string QUERY PARAMETERS skyflow_ids Array of strings List of Record IDs who's objects needs to be fetched. If not present, then all records will be fetched based on offset, limit and ordered by skyflow_id. dlp string Default: "DEFAULT" Enum: "DEFAULT" "PLAIN_TEXT" "TOKEN" DLP to enforce on the data in response.. fields Array of strings Fields that needs to be fetched for the given Record IDs. If not specified, all fields would be fetched.. offset string <int64> Default: "0" Pagination Offset. - indicates the record number to start retrieving data. Not applicable for Token DLP View. limit string <int64> Default: "100" Pagination Limit. - indicates the number of records to retrieve. Not applicable for Token DLP View. RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response get/v1/vaults/{vaultID}/organizations https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/organizations REQUEST SAMPLES * curl Copy curl -i -X GET \ 'https:///%7Borg-name%7D.%7Baccount-name%7D.vault.skyflowapis.com/v1/vaults/:vaultID/organizations?skyflow_ids=string&dlp=DEFAULT&fields=string&offset=0&limit=100' \ -H 'Authorization: YOUR_API_KEY_HERE' RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "records": [ * { * "fields": { * "phone_numbers": [ * { * "value": "593(930)136-9867", * "type": "WORK" } ], * "addresses": [ * { * "full_name": "Briggs Heed", * "use": "HOME", * "line_1": "1 Lakeland Crossing", * "line_2": "0 Corben Place", * "city": "Kamyanyuki", * "district": "El Cerrito", * "country": "PANAMA", * "zip_code": "64737", * "address_type": "BOTH" }, * { * "full_name": "Melania Coule", * "use": "WORK", * "line_1": "5 Cambridge Crossing", * "line_2": "44755 Sherman Plaza", * "city": "Cinyawar", * "district": "Mulifanua", * "country": "INDIA", * "zip_code": "22216", * "address_type": "PHYSICAL" } ], * "emails": [ * { * "value": "ebonifas0@prweb.com", * "type": "PERSONAL" }, * { * "value": "miremonger1@altervista.org", * "type": "OLD" } ], * "is_active": "FALSE", * "type": "Armed Forces", * "name": "Russel and Sons" } } ] } BULK DELETE ORGANIZATIONS Deletes records matching the ID's or all records if '*' is provided as the ID AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string REQUEST BODY SCHEMA: APPLICATION/JSON vaultID string (Vault ID Under from which these records needs to be deleted) skyflow_ids Array of strings (List of Record IDs that needs to be deleted or '*' if all records under organizations needs to be deleted) RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response delete/v1/vaults/{vaultID}/organizations https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/organizations REQUEST SAMPLES * Payload * curl Content type application/json Copy Expand all Collapse all { * "vaultID": "string", * "skyflow_ids": [ * "string" ] } RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "RecordIDResponse": [ * "string" ] } INSERT ORGANIZATIONS Creates a Record for the given Vault ID & organizations AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string REQUEST BODY SCHEMA: APPLICATION/JSON vaultID string (Vault ID for organizations) records Array of objects (The list of records) RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response post/v1/vaults/{vaultID}/organizations https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/organizations REQUEST SAMPLES * Payload * curl Content type application/json Copy Expand all Collapse all { * "records": [ * { * "fields": { * "phone_numbers": [ * { * "value": "593(930)136-9867", * "type": "WORK" } ], * "addresses": [ * { * "full_name": "Briggs Heed", * "use": "HOME", * "line_1": "1 Lakeland Crossing", * "line_2": "0 Corben Place", * "city": "Kamyanyuki", * "district": "El Cerrito", * "country": "PANAMA", * "zip_code": "64737", * "address_type": "BOTH" }, * { * "full_name": "Melania Coule", * "use": "WORK", * "line_1": "5 Cambridge Crossing", * "line_2": "44755 Sherman Plaza", * "city": "Cinyawar", * "district": "Mulifanua", * "country": "INDIA", * "zip_code": "22216", * "address_type": "PHYSICAL" } ], * "emails": [ * { * "value": "ebonifas0@prweb.com", * "type": "PERSONAL" }, * { * "value": "miremonger1@altervista.org", * "type": "OLD" } ], * "is_active": "FALSE", * "type": "Armed Forces", * "name": "Russel and Sons" } } ] } RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "records": [ * { * "skyflow_id": "ae7k43l4-596f-189a-lj45-mk3l3e79df71md", * "createdTime": "2017-07-21T00:56:36.000Z" }, * { * "skyflow_id": "lak49d832-35hj-fhu4-f789-degl3ey6dfdsfb", * "createdTime": "2017-07-21T00:56:36.000Z" } ] } GET ORGANIZATIONS Retrieves a Record by using Row ID of a organizations AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string ID required string QUERY PARAMETERS dlp string Default: "DEFAULT" Enum: "DEFAULT" "PLAIN_TEXT" "TOKEN" DLP to enforce on the data in response. fields Array of strings Fields that needs to be fetched for the given Record ID. If not specified, all fields would be fetched. RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response get/v1/vaults/{vaultID}/organizations/{ID} https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/organizations/{ID} REQUEST SAMPLES * curl Copy curl -i -X GET \ 'https:///%7Borg-name%7D.%7Baccount-name%7D.vault.skyflowapis.com/v1/vaults/:vaultID/organizations/:ID?dlp=DEFAULT&fields=string' \ -H 'Authorization: YOUR_API_KEY_HERE' RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "fields": { * "skyflow_id": "string", * "is_active": "UNKNOWN_BOOL_VALUE", * "type": "string", * "name": "string", * "phone_numbers": [ * { * "value": "string", * "type": "UNSPECIFIED_TYPE" } ], * "addresses": [ * { * "full_name": "string", * "use": "UNSPECIFIED_USE", * "line_1": "string", * "line_2": "string", * "latitude": 0, * "longitude": 0, * "city": "string", * "district": "string", * "country": "UNSPECIFIED_COUNTRY", * "state": "string", * "zip_code": "string", * "address_type": "UNSPECIFIED_ADDRESS_TYPE" } ], * "emails": [ * { * "value": "string", * "type": "UNSPECIFIED_TYPE" } ] } } DELETE ORGANIZATIONS Deletes the object by ID for the given organizations AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string ID required string RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response delete/v1/vaults/{vaultID}/organizations/{ID} https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/organizations/{ID} REQUEST SAMPLES * curl Copy curl -i -X DELETE \ https:///%7Borg-name%7D.%7Baccount-name%7D.vault.skyflowapis.com/v1/vaults/:vaultID/organizations/:ID \ -H 'Authorization: YOUR_API_KEY_HERE' RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "skyflow_id": "string", * "deleted": true } UPDATE ORGANIZATIONS Updates a Record for the given record ID , Vault ID & organizations AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string ID required string REQUEST BODY SCHEMA: APPLICATION/JSON ID string (ID of the Record to Fetch) vaultID string (Vault ID Under for this record) record object (skyfloworganizationsRecords) RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response put/v1/vaults/{vaultID}/organizations/{ID} https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/organizations/{ID} REQUEST SAMPLES * Payload * curl Content type application/json Copy Expand all Collapse all { * "record": { * "fields": { * "phone_numbers": [ * { * "value": "593(930)136-9867", * "type": "WORK" } ], * "addresses": [ * { * "full_name": "Briggs Heed", * "use": "HOME", * "line_1": "1 Lakeland Crossing", * "line_2": "0 Corben Place", * "city": "Kamyanyuki", * "district": "El Cerrito", * "country": "PANAMA", * "zip_code": "64737", * "address_type": "BOTH" }, * { * "full_name": "Melania Coule", * "use": "WORK", * "line_1": "5 Cambridge Crossing", * "line_2": "44755 Sherman Plaza", * "city": "Cinyawar", * "district": "Mulifanua", * "country": "INDIA", * "zip_code": "22216", * "address_type": "PHYSICAL" } ], * "emails": [ * { * "value": "ebonifas0@prweb.com", * "type": "PERSONAL" }, * { * "value": "miremonger1@altervista.org", * "type": "OLD" } ], * "is_active": "FALSE", * "type": "Armed Forces", * "name": "Russel and Sons" } } } RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "skyflow_id": "ae7k43l4-596f-189a-lj45-mk3l3e79df71md", * "updatedTime": "2017-07-21T00:56:36.000Z" } PERSONS BULK GET PERSONS Gets records matching the ID's AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string QUERY PARAMETERS skyflow_ids Array of strings List of Record IDs who's objects needs to be fetched. If not present, then all records will be fetched based on offset, limit and ordered by skyflow_id. dlp string Default: "DEFAULT" Enum: "DEFAULT" "PLAIN_TEXT" "TOKEN" DLP to enforce on the data in response.. fields Array of strings Fields that needs to be fetched for the given Record IDs. If not specified, all fields would be fetched.. offset string <int64> Default: "0" Pagination Offset. - indicates the record number to start retrieving data. Not applicable for Token DLP View. limit string <int64> Default: "100" Pagination Limit. - indicates the number of records to retrieve. Not applicable for Token DLP View. RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response get/v1/vaults/{vaultID}/persons https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/persons REQUEST SAMPLES * curl Copy curl -i -X GET \ 'https:///%7Borg-name%7D.%7Baccount-name%7D.vault.skyflowapis.com/v1/vaults/:vaultID/persons?skyflow_ids=string&dlp=DEFAULT&fields=string&offset=0&limit=100' \ -H 'Authorization: YOUR_API_KEY_HERE' RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "records": [ * { * "fields": { * "addresses": [ * { * "full_name": "Rubetta Mortlock", * "use": "TEMPORARY", * "line_1": "5250 Eliot Point", * "line_2": "02 Dennis Trail", * "city": "Seixo de Manhoses", * "district": "Pavliš", * "country": "CAYMAN_ISLANDS", * "zip_code": "38005", * "address_type": "BOTH" }, * { * "full_name": "Hollis Varker", * "use": "OLD_INCORRECT", * "line_1": "173 Green Ridge Trail", * "line_2": "6209 Prairieview Center", * "city": "Lembang", * "district": "Lukou", * "country": "GUAM", * "zip_code": "26651", * "address_type": "POSTAL" } ], * "phone_numbers": [ * { * "value": "46(544)403-1641", * "type": "OLD" }, * { * "value": "62(146)591-4867", * "type": "TEMP" } ], * "emails": [ * { * "value": "jridout0@joomla.org", * "type": "OLD" }, * { * "value": "jtilt1@about.com", * "type": "OFFICIAL" } ], * "name": { * "prefix": "Honorable", * "first_name": "Rees", * "middle_name": "Aimee", * "last_name": "Pechacek", * "use": "NICKNAME", * "suffix": "III" }, * "date_of_birth": "1963-05-08", * "gender": "OTHER", * "race": "CREE", * "ethnicity": "OTHER_ETHNICITY", * "religion": "EPISCOPALIAN", * "preferred_language": "CAMBODIAN_LANGUAGE", * "nationality": "GUINEAN", * "marital_status": "DOMESTIC_PARTNER" } } ] } BULK DELETE PERSONS Deletes records matching the ID's or all records if '*' is provided as the ID AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string REQUEST BODY SCHEMA: APPLICATION/JSON vaultID string (Vault ID Under from which these records needs to be deleted) skyflow_ids Array of strings (List of Record IDs that needs to be deleted or '*' if all records under persons needs to be deleted) RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response delete/v1/vaults/{vaultID}/persons https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/persons REQUEST SAMPLES * Payload * curl Content type application/json Copy Expand all Collapse all { * "vaultID": "string", * "skyflow_ids": [ * "string" ] } RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "RecordIDResponse": [ * "string" ] } INSERT PERSONS Creates a Record for the given Vault ID & persons AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string REQUEST BODY SCHEMA: APPLICATION/JSON vaultID string (Vault ID for persons) records Array of objects (The list of records) RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response post/v1/vaults/{vaultID}/persons https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/persons REQUEST SAMPLES * Payload * curl Content type application/json Copy Expand all Collapse all { * "records": [ * { * "fields": { * "addresses": [ * { * "full_name": "Rubetta Mortlock", * "use": "TEMPORARY", * "line_1": "5250 Eliot Point", * "line_2": "02 Dennis Trail", * "city": "Seixo de Manhoses", * "district": "Pavliš", * "country": "CAYMAN_ISLANDS", * "zip_code": "38005", * "address_type": "BOTH" }, * { * "full_name": "Hollis Varker", * "use": "OLD_INCORRECT", * "line_1": "173 Green Ridge Trail", * "line_2": "6209 Prairieview Center", * "city": "Lembang", * "district": "Lukou", * "country": "GUAM", * "zip_code": "26651", * "address_type": "POSTAL" } ], * "phone_numbers": [ * { * "value": "46(544)403-1641", * "type": "OLD" }, * { * "value": "62(146)591-4867", * "type": "TEMP" } ], * "emails": [ * { * "value": "jridout0@joomla.org", * "type": "OLD" }, * { * "value": "jtilt1@about.com", * "type": "OFFICIAL" } ], * "name": { * "prefix": "Honorable", * "first_name": "Rees", * "middle_name": "Aimee", * "last_name": "Pechacek", * "use": "NICKNAME", * "suffix": "III" }, * "date_of_birth": "1963-05-08", * "gender": "OTHER", * "race": "CREE", * "ethnicity": "OTHER_ETHNICITY", * "religion": "EPISCOPALIAN", * "preferred_language": "CAMBODIAN_LANGUAGE", * "nationality": "GUINEAN", * "marital_status": "DOMESTIC_PARTNER" } } ] } RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "records": [ * { * "skyflow_id": "ae7k43l4-596f-189a-lj45-mk3l3e79df71md", * "createdTime": "2017-07-21T00:56:36.000Z" }, * { * "skyflow_id": "lak49d832-35hj-fhu4-f789-degl3ey6dfdsfb", * "createdTime": "2017-07-21T00:56:36.000Z" } ] } GET PERSONS Retrieves a Record by using Row ID of a persons AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string ID required string QUERY PARAMETERS dlp string Default: "DEFAULT" Enum: "DEFAULT" "PLAIN_TEXT" "TOKEN" DLP to enforce on the data in response. fields Array of strings Fields that needs to be fetched for the given Record ID. If not specified, all fields would be fetched. RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response get/v1/vaults/{vaultID}/persons/{ID} https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/persons/{ID} REQUEST SAMPLES * curl Copy curl -i -X GET \ 'https:///%7Borg-name%7D.%7Baccount-name%7D.vault.skyflowapis.com/v1/vaults/:vaultID/persons/:ID?dlp=DEFAULT&fields=string' \ -H 'Authorization: YOUR_API_KEY_HERE' RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "fields": { * "skyflow_id": "string", * "name": { * "prefix": "string", * "first_name": "string", * "middle_name": "string", * "last_name": "string", * "use": "UNSPECIFIED_USE", * "suffix": "string" }, * "date_of_birth": "string", * "gender": "UNSPECIFIED", * "race": "UNSPECIFIED_RACE", * "ethnicity": "UNSPECIFIED_ETHNICITY", * "religion": "UNSPECIFIED_RELIGION", * "preferred_language": "UNSPECIFIED_LANGUAGE", * "addresses": [ * { * "full_name": "string", * "use": "UNSPECIFIED_USE", * "line_1": "string", * "line_2": "string", * "latitude": 0, * "longitude": 0, * "city": "string", * "district": "string", * "country": "UNSPECIFIED_COUNTRY", * "state": "string", * "zip_code": "string", * "address_type": "UNSPECIFIED_ADDRESS_TYPE" } ], * "nationality": "UNKNOWN", * "marital_status": "UNSPECIFIED_MARITAL_STATUS", * "phone_numbers": [ * { * "value": "string", * "type": "UNSPECIFIED_TYPE" } ], * "emails": [ * { * "value": "string", * "type": "UNSPECIFIED_TYPE" } ], * "identifiers_skyflow_id": "string", * "contacts_skyflow_id": [ * "string" ] } } DELETE PERSONS Deletes the object by ID for the given persons AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string ID required string RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response delete/v1/vaults/{vaultID}/persons/{ID} https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/persons/{ID} REQUEST SAMPLES * curl Copy curl -i -X DELETE \ https:///%7Borg-name%7D.%7Baccount-name%7D.vault.skyflowapis.com/v1/vaults/:vaultID/persons/:ID \ -H 'Authorization: YOUR_API_KEY_HERE' RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "skyflow_id": "string", * "deleted": true } UPDATE PERSONS Updates a Record for the given record ID , Vault ID & persons AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string ID required string REQUEST BODY SCHEMA: APPLICATION/JSON ID string (ID of the Record to Fetch) vaultID string (Vault ID Under for this record) record object (skyflowpersonsRecords) RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response put/v1/vaults/{vaultID}/persons/{ID} https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/persons/{ID} REQUEST SAMPLES * Payload * curl Content type application/json Copy Expand all Collapse all { * "record": { * "fields": { * "addresses": [ * { * "full_name": "Rubetta Mortlock", * "use": "TEMPORARY", * "line_1": "5250 Eliot Point", * "line_2": "02 Dennis Trail", * "city": "Seixo de Manhoses", * "district": "Pavliš", * "country": "CAYMAN_ISLANDS", * "zip_code": "38005", * "address_type": "BOTH" }, * { * "full_name": "Hollis Varker", * "use": "OLD_INCORRECT", * "line_1": "173 Green Ridge Trail", * "line_2": "6209 Prairieview Center", * "city": "Lembang", * "district": "Lukou", * "country": "GUAM", * "zip_code": "26651", * "address_type": "POSTAL" } ], * "phone_numbers": [ * { * "value": "46(544)403-1641", * "type": "OLD" }, * { * "value": "62(146)591-4867", * "type": "TEMP" } ], * "emails": [ * { * "value": "jridout0@joomla.org", * "type": "OLD" }, * { * "value": "jtilt1@about.com", * "type": "OFFICIAL" } ], * "name": { * "prefix": "Honorable", * "first_name": "Rees", * "middle_name": "Aimee", * "last_name": "Pechacek", * "use": "NICKNAME", * "suffix": "III" }, * "date_of_birth": "1963-05-08", * "gender": "OTHER", * "race": "CREE", * "ethnicity": "OTHER_ETHNICITY", * "religion": "EPISCOPALIAN", * "preferred_language": "CAMBODIAN_LANGUAGE", * "nationality": "GUINEAN", * "marital_status": "DOMESTIC_PARTNER" } } } RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "skyflow_id": "ae7k43l4-596f-189a-lj45-mk3l3e79df71md", * "updatedTime": "2017-07-21T00:56:36.000Z" } QUERY QUERY RECORD Retrieves Records by using the query provided AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string REQUEST BODY SCHEMA: APPLICATION/JSON vaultID string (Vault ID Under for which the query should be run) query string (The query to fire) RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response post/v1/vaults/{vaultID}/query https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/query REQUEST SAMPLES * Payload * curl Content type application/json Copy Expand all Collapse all { * "query": "select * from persons where skyflow_id='04c1feec-fda0-11ea-b6ad-a683e75f717a'" } RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "records": [ * { * "fields": { * "Opportunity Name": "BPS Pilot", * "Owner": { * "id": "usrijG9SC4EQlq5cm", * "email": "kat+collab15@skyflow.com", * "name": "Jess Patel" }, * "Status": "Qualification", * "Priority": "Medium", * "Estimated Value": 10000, * "Proposal Deadline": "2017-06-14", * "Expected Close Date": "2017-07-12" } }, * { * "fields": { * "Opportunity Name": "BPS second use case", * "Owner": { * "id": "usrGqHsNLhH41Q91M", * "email": "kat+collab36@skyflow.com", * "name": "Sandy Hagen" }, * "Status": "Proposal", * "Priority": "Very Low Deprioritize", * "Estimated Value": 24791, * "Expected Close Date": "2017-07-07" } } ] } TOKENS BULK GET RECORD BY TOKENS Retrieves all records using the token IDs AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string QUERY PARAMETERS token_ids Array of strings List of Token IDs who's records needs to be fetched. dlp string Default: "DEFAULT" Enum: "DEFAULT" "PLAIN_TEXT" DLP to enforce on the data in response. RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response get/v1/vaults/{vaultID}/tokens https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/tokens REQUEST SAMPLES * curl Copy curl -i -X GET \ 'https:///%7Borg-name%7D.%7Baccount-name%7D.vault.skyflowapis.com/v1/vaults/:vaultID/tokens?token_ids=string&dlp=DEFAULT' \ -H 'Authorization: YOUR_API_KEY_HERE' RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "records": [ * { * "fields": { * "Opportunity Name": "BPS Pilot", * "Owner": { * "id": "usrijG9SC4EQlq5cm", * "email": "kat+collab15@skyflow.com", * "name": "Jess Patel" }, * "Status": "Qualification", * "Priority": "Medium", * "Estimated Value": 10000, * "Proposal Deadline": "2017-06-14", * "Expected Close Date": "2017-07-12" } }, * { * "fields": { * "Opportunity Name": "BPS second use case", * "Owner": { * "id": "usrGqHsNLhH41Q91M", * "email": "kat+collab36@skyflow.com", * "name": "Sandy Hagen" }, * "Status": "Proposal", * "Priority": "Very Low Deprioritize", * "Estimated Value": 24791, * "Expected Close Date": "2017-07-07" } } ] } GET RECORD BY TOKEN Retrieves a Record by using Token ID AUTHORIZATIONS: Bearer PATH PARAMETERS vaultID required string ID required string QUERY PARAMETERS dlp string Default: "DEFAULT" Enum: "DEFAULT" "PLAIN_TEXT" DLP to enforce on the data in response. RESPONSES 200 A successful response. 404 Returned when the resource does not exist. default An unexpected error response get/v1/vaults/{vaultID}/tokens/{ID} https://{org-name}.{account-name}.vault.skyflowapis.com/v1/vaults/{vaultID}/tokens/{ID} REQUEST SAMPLES * curl Copy curl -i -X GET \ 'https:///%7Borg-name%7D.%7Baccount-name%7D.vault.skyflowapis.com/v1/vaults/:vaultID/tokens/:ID?dlp=DEFAULT' \ -H 'Authorization: YOUR_API_KEY_HERE' RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "fields": { * "Opportunity Name": "BPS Pilot", * "Owner": { * "id": "usrijG9SC4EQlq5cm", * "email": "kat+collab15@skyflow.com", * "name": "Jess Patel" }, * "Status": "Qualification", * "Priority": "Medium", * "Estimated Value": 10000, * "Proposal Deadline": "2017-06-14", * "Expected Close Date": "2017-07-12" } }