CiviCRM Stack Exchange is a question and answer site for administrators and users of the CiviCRM Constituent Relationship Management software. It only takes a minute to sign up.
Sign up to join this community
Is there a way to explore the API from the command line instead of going to mycivicrmsite.localhost/civicrm/api in a web browser?
I wasn't able to learn much from the cv help. For example, you can cv api contact.get... but what else can you cv api contact.do?
I know I can just go over to the web browser and pull up that page, but I just wanna hang out in my terminal :)
The graphical api explorer actually fetches all its information about the api from the api. Since the CiviCRM api is available from the command line, you can explore it using the same methods.
Fetch the list of entities:
$ cv api Entity.get
List available actions for an entity:
$ cv api Activity.getactions
Get fields for an entity/action:
$ cv api Activity.getfields action=create
cv if that was printed in the output of cv api --help. I think I'm going have a lot of questions around this and I'm not sure how much I should post those here. It looks like there's not much "Getting started with CiviCRM's CLI" tutorial around, I'd be glad to contribute towards one.
– alec
Sep 1 '18 at 16:10
cv api Setting.get | peco is a helpful way to explore all that json output. Thanks again!
– alec
Sep 1 '18 at 16:37
