Retrieve method

This method allows you to retrieve records from a table given either their keys or ids. The order the records are returned may not match the order ids/keys are passed in.

Parameters

table

the singular name of the table or its alias as returned by the Describe (Database) method. Please note that this parameter is embedded into the URL before the method name.

column

the name or an alias of the column to query can appear multiple times. If omitted or star (*) is specified, API returns the data for all updateable columns. You can combine star with other column names.

key or id

the value of key column or internal record id to retrieve. Can appear multiple times. You cannot mix keys with ids. You cannot retrieve more than 500 records at once.

Request

GET https://www.teamdesk.net/secure/api/v2/{appid}/{table}/retrieve.{json|xml}?params 

Retrieve Id and Text column from records with keys 56 and 57

GET https://www.teamdesk.net/secure/api/v2/21995/Test/retrieve.json?column=Id&column=Text&key=56&key=57

Retrieve Id and Text column from records with ids 56 and 57

GET https://www.teamdesk.net/secure/api/v2/21995/Test/retrieve.json?column=Id&column=Text&id=56&id=57

Response

Response matches the format returned by Select (Table) method.