API parameters/operators list

[Konstantin]

Hi All,

Sorry if this topic has already been discussed—please feel free to forward me to it if that's the case.

I'm currently working on integrating Simpro with Excel and was wondering if there's a complete list of all available API parameters and operators published somewhere.

At the moment, I'm trying to get columns like Site Location, Site Phone, and Site Email—ideally through the Job List request or by querying a specific job using its job number.

Can you please let me know if there are any options available?

Thank you.

[SimproAPITeam]

Hi,

These are all the fields you can get from a job ID

https://developer.simprogroup.com/apido ... 9cbb093702

To get more information from the site you will need to use the site endpoint to get.

https://developer.simprogroup.com/apido ... fe655d382e

You can use ?display=all but for jobs it will only be for the section and cost centers

https://developer.simprogroup.com/apido ... bresources

[Konstantin]

Oh, I see now. That should help. Thank you.
But to get the site zone or site contact details, I need to post a separate request for every site I need. That way, I can run out of the request limit quite quickly. Is there a way to get those in a bunch?

[SimproAPITeam]

Hi,
To get specific columns that are usually returned for individual sites you can add these as parameters in list view.

Try and update your url like this:

Code: Select all

/sites/?columns=ID,Zone,PrimaryContact

Regards

[Konstantin]

Hi,
To get specific columns that are usually returned for individual sites you can add these as parameters in list view.

Try and update your url like this:

Code: Select all

/sites/?columns=ID,Zone,PrimaryContact

Regards

Yeap, that's what I ended up using. Thank you.
Can you please let me know where I can get the "Scheduled" value for a specific job?

[Konstantin]

Found it though AI...
https://XXXXX.simprosuite.com/api/v1.0/ ... schedules/
But could not find it on your website. That's why I'm asking if there is a list of such stuff anywhere, so I don't need to annoy everyone here or need to find some weird ways of searching for this...
If there is such a thing as an API Reference / Function Signature (as a list or a tree) for the SimPro API, can you please refer me to that?
Thank you.

[garethhockley]

Admin test